Leaderboard

Description#

Return students record in descending order base on student points

Method#

GET/POST

Endpoint#

/admin/api.php?f=leaderboard

Header#

Content-Type: application/x-www-form-urlencoded

Body (Optional)#

Filter by school name#

school_name={schoolname}

Filter by grade level#

grade_level={gradelevel}

Filter by school name and grade level#

school_name={schoolname}&grade_level={gradelevel}

Response#

Success#

{
    result: "success",         //String
    content: [                 //Array of Objects
        {
        id: int,
        user_id: int,
        firstname: string,
        lastname: string,
        gradelevel: int,
        schoolname: int,
        preferences: string,
        points: int
      }
    ]
}

Fail#

{
    result: "fail"            //String
}

Example#

Javascript#

GET Request#

const leaderboard = async () => {
    const response = await fetch('http://stockknowledge.org/admin/api.php?f=leaderboard');
    return await response.json();
}

POST Request#

const leaderboard = async () => {
    const response = await fetch('http://stockknowledge.org/admin/api.php?f=leaderboard',{
        method: 'POST',
        body: 'grade_level=1',
        headers: {
            'Content-Type': 'application/x-www-form-urlencoded'
        }
    });
    return await response.json();
}